home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / c2man-2.0pl33.lha / c2man-2.0 / amiga / README < prev    next >
Encoding:
Text File  |  1995-01-26  |  2.0 KB  |  51 lines
  1. This is my port of the c2man patchlevel 33 for the Amiga.
  2.  
  3. I added a Commodore AutoDoc output format backend. So you can use this outputs
  4. with your favorite autodoc formatting utility. Read the c2man manual for
  5. getting started with c2man. If you have groff, a LaTeX package or makeinfo
  6. installed you can also use c2man for generating these output formats. I have
  7. tested the nroff format with the groff port 1.07.
  8.  
  9. I have compiled c2man with SAS-C V6.51 with the STACKCHECK option ON , because
  10. c2man requires more than the standard 4096 bytes. If you don't like this
  11. recompile it , but you must have bison/yacc and flex/lex ! A stack of 10000
  12. bytes seems enough .
  13.  
  14. For this port I used the popen implementation from the AmiTCP 4.0 demo package.
  15. The original version was written by Rick Schaeffer <ricks@isc-br.isc-br.com> and
  16. by Jarno Rajahalme from the AmiTCP/IP Group <Jarno.Rajahalme@hut.fi>.
  17.  
  18. You need also a preprocessor, which supports non-stripping of comments ! I used
  19. the cpp from the AmiTCP 4.0 demo package, but you can also use the cpp from gcc
  20. or gcc with "gcc -E -C".
  21.  
  22. The following option is added in the Amiga port :
  23.  
  24. -T a : select autodoc output format. This output format is default !
  25.  
  26. The following command shows, how you can use the c2man program (Note: this
  27. implies, that you have installed the Pipe package) :
  28.  
  29. c2man -o- your_c_source.c
  30.  
  31. c2man supports grouping of source files. This means if two source files are
  32. passed on the command line, each function in this files links to each other.
  33. But if you have two or more groups of such files you can use the following
  34. command :
  35.  
  36. c2man -o- csource1.c csource2.c || c2man -o- anothercsource.c | sortad to test.doc
  37.  
  38. This functions with the Pipe1_5.lha package, which uses the '||' to concate outputs.
  39.  
  40. sortad is used to put all docs together and to generate the sorted list of contents.
  41.  
  42. sortad is copyrighted by Stefan Ruppert, but is freely distributable with c2man !
  43.  
  44. Stefan Ruppert
  45. Windthorststraße 5
  46. 65439 Flörsheim am Main
  47. GERMANY
  48.  
  49. EMail: ruppert@vs3.informatik.fh-wiesbaden.de
  50.  
  51.